battmon5 2.2.1
Loading...
Searching...
No Matches
battmon5.h File Reference

This file contains API for BATT-MON 5 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  battmon5_t
 BATT-MON 5 Click context object. More...
struct  battmon5_cfg_t
 BATT-MON 5 Click configuration object. More...

Macros

#define BATTMON5_REG_BEFORE_RSOC   0x04
 BATT-MON 5 register map.
#define BATTMON5_REG_TSENSE_THERM_B   0x06
#define BATTMON5_REG_INITIAL_RSOC   0x07
#define BATTMON5_REG_CELL_TEMP   0x08
#define BATTMON5_REG_CELL_V   0x09
#define BATTMON5_REG_CURRENT_DIR   0x0A
#define BATTMON5_REG_APA   0x0B
#define BATTMON5_REG_APT   0x0C
#define BATTMON5_REG_RSOC   0x0D
#define BATTMON5_REG_ITE   0x0F
#define BATTMON5_REG_IC_VERSION   0x11
#define BATTMON5_REG_CHANGE_PARAM   0x12
#define BATTMON5_REG_ALARM_LOW_RSOC   0x13
#define BATTMON5_REG_ALARM_LOW_CELL_V   0x14
#define BATTMON5_REG_IC_POWER_MODE   0x15
#define BATTMON5_REG_STATUS   0x16
#define BATTMON5_REG_BATT_STATUS   0x19
#define BATTMON5_REG_NUM_PARAM   0x1A
#define BATTMON5_REG_TERM_CURRENT   0x1C
#define BATTMON5_REG_EMPTY_CELL_V   0x1D
#define BATTMON5_REG_ITE_OFFSET   0x1E
#define BATTMON5_APA_50MAH   0x1313
 BATT-MON 5 APA register setting.
#define BATTMON5_APA_100MAH   0x1515
#define BATTMON5_APA_200MAH   0x1818
#define BATTMON5_APA_500MAH   0x2121
#define BATTMON5_APA_1000MAH   0x2D2D
#define BATTMON5_APA_2000MAH   0x3A3A
#define BATTMON5_APA_3000MAH   0x3F3F
#define BATTMON5_APA_4000MAH   0x4242
#define BATTMON5_APA_5000MAH   0x4444
#define BATTMON5_APA_6000MAH   0x4545
#define BATTMON5_CHANGE_PARAM_3_7_V   0x0000
 BATT-MON 5 CHANGE_PARAM register setting.
#define BATTMON5_CHANGE_PARAM_PANASONIC   0x0001
#define BATTMON5_CHANGE_PARAM_SAMSUNG   0x0002
#define BATTMON5_CHANGE_PARAM_3_8_V   0x0003
#define BATTMON5_CHANGE_PARAM_3_85_V   0x0004
#define BATTMON5_IC_POWER_MODE_NORMAL   0x0001
 BATT-MON 5 IC_POWER_MODE register setting.
#define BATTMON5_IC_POWER_MODE_SLEEP   0x0002
#define BATTMON5_BATT_STATUS_CLEAR   0x0000
 BATT-MON 5 BATT_STATUS register setting.
#define BATTMON5_BATT_STATUS_LOW_CELL_V   0x0800
#define BATTMON5_BATT_STATUS_LOW_RSOC   0x0200
#define BATTMON5_BATT_STATUS_INIT   0x0080
#define BATTMON5_DEVICE_ADDRESS   0x0B
 BATT-MON 5 device address setting.
#define BATTMON5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  battmon5_return_value_t { BATTMON5_OK = 0 , BATTMON5_ERROR = -1 }
 BATT-MON 5 Click return value data. More...

Functions

void battmon5_cfg_setup (battmon5_cfg_t *cfg)
 BATT-MON 5 configuration object setup function.
err_t battmon5_init (battmon5_t *ctx, battmon5_cfg_t *cfg)
 BATT-MON 5 initialization function.
err_t battmon5_default_cfg (battmon5_t *ctx)
 BATT-MON 5 default configuration function.
err_t battmon5_write_reg (battmon5_t *ctx, uint8_t reg, uint16_t data_in)
 BATT-MON 5 write reg function.
err_t battmon5_read_reg (battmon5_t *ctx, uint8_t reg, uint16_t *data_out)
 BATT-MON 5 read reg function.
uint8_t battmon5_get_alarm_pin (battmon5_t *ctx)
 BATT-MON 5 get alarm pin function.

Detailed Description

This file contains API for BATT-MON 5 Click Driver.

Enumeration Type Documentation

◆ battmon5_return_value_t

BATT-MON 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
BATTMON5_OK 
BATTMON5_ERROR